-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Documented the RestartableJenkinsRule
#7754
Documented the RestartableJenkinsRule
#7754
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @StefanSpieker for the PR! I have made some minor edit suggestions.
Co-authored-by: Kris Stern <[email protected]>
Thanks for the suggestions, @krisstern ! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! I like the documentation, but think that the heading should be changed from "Testing Durable Pipeline Steps" to "Testing Jenkins Restart", since the example is showing a test with a FreeStyleProject
rather than a Pipeline step.
I don't think we should use RestartableJenkinsRule
to test Pipeline steps because the workflow-durable-task-step
plugin is no longer using RestartableJenkinsRule
. It migrated from RestartableJenkinsRule
to JenkinsSessionRule
in this pull request:
It added RealJenkinsRule
based tests in these pull requests:
- [JENKINS-52165] Stabilize and better test
USE_WATCHING
jenkinsci/workflow-durable-task-step-plugin#323 - Build fails to resume if controller crashes before queue is saved jenkinsci/workflow-durable-task-step-plugin#408
I think that documenting RestartableJenkinsRule
is great. Thanks for doing it!
Co-authored-by: Mark Waite <[email protected]>
Thanks @MarkEWaite! You are right, since I just kept the existing headline, it does not really make sense. I will add some documentation for the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
Documented the
RestartableJenkinsRule
also created a very small example to showcase how it can be used.